pretty-bytes

What is pretty-bytes?

The pretty-bytes npm package is a utility that converts bytes to a human-readable string. It takes a numeric value representing the number of bytes and returns a string with a more readable format, including the appropriate unit such as bytes, kilobytes, megabytes, etc.

What are pretty-bytes's main functionalities?

Convert bytes to a human-readable string

This feature allows you to convert a numeric value of bytes into a string that represents the size in a more understandable format, automatically choosing the right unit.

const prettyBytes = require('pretty-bytes');
console.log(prettyBytes(1024)); // '1 kB'

Convert bytes to a human-readable string with options

This feature allows you to specify options such as using binary (IEC) units instead of metric (SI) units, which changes the way the units are calculated and displayed.

const prettyBytes = require('pretty-bytes');
console.log(prettyBytes(1000, {binary: true})); // '1000 B'
console.log(prettyBytes(1024, {binary: true})); // '1 KiB'

Locale support

This feature allows you to format the number using a locale string, which affects the output by using the appropriate decimal separator and grouping for the specified locale.

const prettyBytes = require('pretty-bytes');
console.log(prettyBytes(123456789, {locale: 'de'})); // '123,5 MB'

Other packages similar to pretty-bytes

filesize

The filesize package provides similar functionality to pretty-bytes, allowing for human-readable file size strings from byte amounts. It offers additional options for customization, such as setting the number of decimal places, and has methods for partial application.

bytes

The bytes package is another alternative that formats byte sizes into human-readable strings. It supports conversion from a string with a unit back to bytes, which pretty-bytes does not do.

README

pretty-bytes

Convert bytes to a human readable string: 1337 → 1.34 kB

Useful for displaying file sizes for humans.

Note that it uses base-10 (eg. kilobyte).
Read about the difference between kilobyte and kibibyte.

Install

$ npm install --save pretty-bytes

$ bower install --save pretty-bytes

$ component install sindresorhus/pretty-bytes

Usage

prettyBytes(1337);
//=> '1.34 kB'

prettyBytes(100);
//=> '100 B'

CLI

$ npm install --global pretty-bytes

$ pretty-bytes --help

  Usage
    $ pretty-bytes <number>
    $ echo <number> | pretty-bytes

  Example
    $ pretty-bytes 1337
    1.34 kB

License

MIT © Sindre Sorhus